3D Graphics Programming with QuickDraw 3D 1.5.4

Previous | QD3D Book | Overview | Chapter Contents | Next

Creating and Editing Bitmap Markers

QuickDraw 3D provides routines that you can use to create and manipulate bitmap markers. See "Markers" for the definition of a bitmap marker.

Q3Marker_New

You can use the Q3Marker_New function to create a new marker.

TQ3GeometryObject Q3Marker_New (const TQ3MarkerData *markerData);
markerData
A pointer to a TQ3MarkerData structure.

DESCRIPTION

The Q3Marker_New function returns, as its function result, a new marker having the location, shape, offset, and attributes specified by the markerData parameter. If a new marker could not be created, Q3Marker_New returns the value NULL .

Q3Marker_Submit

You can use the Q3Marker_Submit function to submit an immediate marker for drawing, picking, bounding, or writing.

TQ3Status Q3Marker_Submit (
                     const TQ3MarkerData *markerData,
                     TQ3ViewObject view);
markerData
A pointer to a TQ3MarkerData structure.
view
A view.

DESCRIPTION

The Q3Marker_Submit function submits for drawing, picking, bounding, or writing the immediate marker whose location, shape, offset, and attribute set are specified by the markerData parameter. The marker is drawn, picked, bounded, or written according to the view characteristics specified in the view parameter.

SPECIAL CONSIDERATIONS

You should call this function only in a submitting loop.

Q3Marker_GetData

You can use the Q3Marker_GetData function to get the data associated with a marker.

TQ3Status Q3Marker_GetData (
                     TQ3GeometryObject marker,
                     TQ3MarkerData *markerData);
marker
A marker.
markerData
On exit, a pointer to a TQ3MarkerData structure.

DESCRIPTION

The Q3Marker_GetData function returns, through the markerData parameter, information about the marker specified by the marker parameter. QuickDraw 3D allocates memory for the TQ3MarkerData structure internally; you must call Q3Marker_EmptyData to dispose of that memory.

Q3Marker_SetData

You can use the Q3Marker_SetData function to set the data associated with a marker.

TQ3Status Q3Marker_SetData (
                     TQ3GeometryObject marker,
                     const TQ3MarkerData *markerData);
marker
A marker.
markerData
A pointer to a TQ3MarkerData structure.

DESCRIPTION

The Q3Marker_SetData function sets the data associated with the marker specified by the marker parameter to the data specified by the markerData parameter.

Q3Marker_EmptyData

You can use the Q3Marker_EmptyData function to release the memory occupied by the data structure returned by a previous call to Q3Marker_GetData .

TQ3Status Q3Marker_EmptyData (TQ3MarkerData *markerData);
markerData
A pointer to a TQ3MarkerData structure.

DESCRIPTION

The Q3Marker_EmptyData function releases the memory occupied by the TQ3MarkerData structure pointed to by the markerData parameter; that memory was allocated by a previous call to Q3Marker_GetData .

Q3Marker_GetPosition

You can use the Q3Marker_GetPosition function to get the position of a marker.

TQ3Status Q3Marker_GetPosition (
                     TQ3GeometryObject marker,
                     TQ3Point3D *location);
marker
A marker.
location
On exit, the location of the specified marker.

DESCRIPTION

The Q3Marker_GetPosition function returns, in the location parameter, the location of the marker specified by the marker parameter.

Q3Marker_SetPosition

You can use the Q3Marker_SetPosition function to set the position of a marker.

TQ3Status Q3Marker_SetPosition (
                     TQ3GeometryObject marker,
                     const TQ3Point3D *location);
marker
A marker.
location
The desired location of the specified marker.

DESCRIPTION

The Q3Marker_SetPosition function sets the position of the marker specified by the marker parameter to the point specified in the position parameter.

Q3Marker_GetXOffset

You can use the Q3Marker_GetXOffset function to get the horizontal offset of a marker.

TQ3Status Q3Marker_GetXOffset (TQ3GeometryObject marker, long *xOffset);
marker
A marker.
xOffset
On exit, the horizontal offset of the specified marker.

DESCRIPTION

The Q3Marker_GetXOffset function returns, in the xOffset parameter, the horizontal offset of the marker specified by the marker parameter.

Q3Marker_SetXOffset

You can use the Q3Marker_SetXOffset function to set the horizontal offset of a marker.

TQ3Status Q3Marker_SetXOffset (TQ3GeometryObject marker, long xOffset);
marker
A marker.
xOffset
The desired horizontal offset of the specified marker.

DESCRIPTION

The Q3Marker_SetXOffset function sets the horizontal offset of the marker specified by the marker parameter to the value specified in the xOffset parameter.

Q3Marker_GetYOffset

You can use the Q3Marker_GetYOffset function to get the vertical offset of a marker.

TQ3Status Q3Marker_GetYOffset (TQ3GeometryObject marker, long *yOffset);
marker
A marker.
yOffset
On exit, the vertical offset of the specified marker.

DESCRIPTION

The Q3Marker_GetYOffset function returns, in the yOffset parameter, the vertical offset of the marker specified by the marker parameter.

Q3Marker_SetYOffset

You can use the Q3Marker_SetYOffset function to set the vertical offset of a marker.

TQ3Status Q3Marker_SetYOffset (TQ3GeometryObject marker, long yOffset);
marker
A marker.
yOffset
The desired vertical offset of the specified marker.

DESCRIPTION

The Q3Marker_SetYOffset function sets the vertical offset of the marker specified by the marker parameter to the value specified in the yOffset parameter.

Q3Marker_GetBitmap

You can use the Q3Marker_GetBitmap function to get the bitmap of a marker.

TQ3Status Q3Marker_GetBitmap (
                     TQ3GeometryObject marker,
                     TQ3Bitmap *bitmap);
marker
A marker.
bitmap
On exit, the bitmap of the specified marker.

DESCRIPTION

The Q3Marker_GetBitmap function returns, in the bitmap parameter, a copy of the bitmap of the marker specified by the marker parameter. Q3Marker_GetBitmap allocates memory internally for the returned bitmap; when you're done using the bitmap, you should call the Q3Bitmap_Empty function to dispose of that memory.

Q3Marker_SetBitmap

You can use the Q3Marker_SetBitmap function to set the bitmap of a marker.

TQ3Status Q3Marker_SetBitmap (
                     TQ3GeometryObject marker,
                     const TQ3Bitmap *bitmap);
marker
A marker.
bitmap
The desired bitmap of the specified marker.

DESCRIPTION

The Q3Marker_SetBitmap function sets the bitmap of the marker specified by the marker parameter to that specified in the bitmap parameter. Q3Marker_SetBitmap copies the bitmap to internal QuickDraw 3D memory, so you can dispose of the specified bitmap after calling Q3Marker_SetBitmap .

© 1997 Apple Computer, Inc.

Previous | QD3D Book | Overview | Chapter Contents | Next